Skip to main content
Feedback

Get Model

The Get Model operation retrieves the XML representation of a specified model in a specified account accessible to the authenticating user.

The model version to retrieve is optionally specified in the request. If the model version is not specified in the request, it retrieves the latest published version.

  • To perform this operation to retrieve the latest published version of a model, send an HTTP GETrequest to:

    https://api.boomi.com/mdm/api/rest/v1/<accountID>/models/<modelID>

  • To perform this operation to retrieve a specific published version of a model, send an HTTP GET request to:

    https://api.boomi.com/mdm/api/rest/v1/<accountID>/models/<modelID?version=<version>

  • To perform this operation to retrieve the draft version of a model, send an HTTP GET request to:

    https://api.boomi.com/mdm/api/rest/v1/<accountID>/models/<modelID>?draft=true

note

This operation requires the authenticating user to have the MDM - View Models privilege and the API Access privilege.

You can implement requests for this operation in processes using the HTTP Client connector.

Path parameters

accountID
ID of the account

modelID
ID of the model

Query parameters

version
(Optional) Version number of the specified model to retrieve

draft
(Optional) If set to true, the request is to retrieve the draft version of the specified model. It ignores any other value.

If you omit both parameters, the request is to retrieve the latest published version of the specified model. If you include both parameters, version takes precedence.

Responses

  • 200 (OK) The body of the response is XML. The root element, <mdm:GetModelResponse> represents the model, as detailed in the topic Model XML representation:

  • 400 (Bad Request) The value of the version parameter is invalid. Sample response body:

    <error>
       <message>Query parameter version has invalid value</message>
    </error>

  • 400 (Bad Request) The authenticating user does not have the API Access and MDM - View Models privileges required for this operation. Sample response body:

    <error>
        <message>The authenticated user does not have access rights to this functionality</message>
    </error>

  • 400 (Bad Request) modelID is not a valid GUID and is therefore an invalid component ID. Sample response body:

    <error>
        <message>1 is not a valid component ID.</message>
    </error>

  • 400 (Bad Request) modelID does not identify a model in the specified account. Sample response body:

    <error>
        <message>A model with ID 851a6a64-6a88-4916-a5b7-d6a974d54318 does not exist.</message>
    </error>

  • 400 (Bad Request) The modelID and version combination does not identify a model version in the specified account. Sample response body:

    <error>
        <message>A component with ID 851a6a64-6a88-4916-a5b7-d6a974d54318 and version 100 does not exist.</message>
    </error>

  • 400 (Bad Request) A draft version of a model with ID modelID does not exist. Sample response body:

    <error>
        <message>The model does not currently have a Draft version</message>
    </error>

  • 400 (Bad Request) The value of the version parameter is invalid. Sample response body:

    <error>
        <message>Query parameter version has invalid value</message>
    </error>

  • 403 (Forbidden) Authentication failure. Sample response body:

    <UserMessage id="error.user.login" type="error">
        <Data>Incorrect user name and password combination.</Data>
    </UserMessage>

  • 403 (Forbidden) accountID does not identify an account accessible to the authenticating user. Sample response body:

    <UserMessage id="error.user.login" type="error">
        <Data>Incorrect user name and password combination.</Data>
    </UserMessage>
On this Page